diff --git a/README.md b/README.md index 16972a8b..db51983b 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,18 @@ # Ultramarine Linux Wiki -This wiki is meant to be the extended documentation for both end users and developers, so it is separated in those two categories. Made with Astro and a modification of the default blog template. +Welcome to the source repository behind the [Ultramarine Wiki]! We welcome any contributions and +you may freely send pull requests to this repository if you would like to modify any of the +content here! -## 🧞 Commands +## Translations -All commands are run from the root of the project, from a terminal: +If you'd like to translate for a new language: -| Command | Action | -| :---------------------- | :----------------------------------------------- | -| `pnpm install` | Installs dependencies | -| `pnpm run dev` | Starts local dev server at `localhost:3000` | -| `pnpm run build` | Build your production site to `./dist/` | -| `pnpm run preview` | Preview your build locally, before deploying | -| `pnpm run astro ...` | Run CLI commands like `astro add`, `astro check` | -| `pnpm run astro --help` | Get help using the Astro CLI | +1. Go to `src/consts.ts` to add a new language into `KNOWN_LANGUAGES` +2. Copy everything from `src/content/docs/en` to `src/content/docs/`[^1] +3. Add pages into `SIDEBAR` in `src/consts.ts` +4. Start translating! + +[^1]: We encourage you to use a generic language code without limiting the region. + +[Ultramarine Wiki]: https://wiki.ultramarine-linux.org