generated from just-the-docs/just-the-docs-template
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
The README is now heavily templated with purple text both representing the template text to be removed AND text that explains the expected input into the template In the top of the README is now a quick start guide, that needs to be removed, after completed.
- Loading branch information
Showing
1 changed file
with
31 additions
and
27 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,40 +1,44 @@ | ||
| # OS2 Documentation Template | ||
| > [!WARNING] Remove this section from your README.md after completing all setup tasks! | ||
| > - [ ] Click the green "Use this template" button above. | ||
| > - [ ] Name your new repository and create it. | ||
| > - [ ] Replace all the purple placeholder texts with your project-specific information. | ||
| > - [ ] Add any additional relevant Markdown documents to your documentation. | ||
| > - [ ] Configure a [publishing source for GitHub Pages](https://help.github.com/en/articles/configuring-a-publishing-source-for-github-pages). | ||
| > - [ ] **Remove this setup section from your README.md.** | ||
| > | ||
| > That's it! You are now set up, and your documentation site is live! | ||
| This template helps you quickly set up documentation for your OS2 project. | ||
|
|
||
| ## Quick Start | ||
| # [Replace with Project Title] | ||
| > [!IMPORTANT] [Replace with a clear statement defining the mission and goals of your project in simple terms.] | ||
| 1. Click the green "Use this template" button above. | ||
| 2. Name your new repository and create it. | ||
| 3. Start with the `PROJECT_README_TEMPLATE.md` file and | ||
| 4. Replace this Quick Start by renaming `PROJECT_README_TEMPLATE.md` to `README.md`: | ||
|
|
||
| 5. Configure a [publishing source for GitHub Pages](https://help.github.com/en/articles/configuring-a-publishing-source-for-github-pages). | ||
| [How It Works](#how-this-codebase-achieves-its-objectives) | [Project Architecture](#architecture) | [Installation](#installation) | [Usage](#usage) | [Contributing](#contributing) | [License](#license) | [Contact](#contact) | ||
|
|
||
| That's it! Your project documentation scafolding is now set up and your documentation site is now live! | ||
|
|
||
| ## 🧭 How It Works | ||
| > [!IMPORTANT]Replace with a brief, clear explanation of how the codebase works to achieve the stated mission objectives. | ||
| ## Contributing | ||
| #### Architecture | ||
|
|
||
| Feel free to contribute, to get started check out our [CONTRIBUTING.md](./CONTRIBUTING.md) guide | ||
| > [!IMPORTANT] Replace with a Brief introduction to the project's high-level architecture. Link to an ARCHITECTURE.MD diagram e.g. in mermaid syntax | ||
| ## Licensing and Attribution | ||
| #### Key Features | ||
|
|
||
| This repository is licensed under the [MIT License][MIT License]. You are generally free to reuse or extend upon this code as you see fit; just include the original copy of the license (which is preserved when you "make a template"). While it's not necessary, we'd love to hear from you if you do use this template, and how we can improve it for future use! | ||
| > [!IMPORTANT] Replace this with a brief explaination of the main features or functionalities of your project.] | ||
| The deployment GitHub Actions workflow is heavily based on GitHub's mixed-party [starter workflows][starter workflows]. A copy of their MIT License is available in [actions/starter-workflows][actions/starter-workflows]. | ||
|
|
||
| ## :arrow_heading_down: Installation | ||
| > [!IMPORTANT] Replace with Step-by-step instructions on how to install the codebase. | ||
| ## ▶️ How to Run | ||
| > [!IMPORTANT] Replace with clear, concise instructions on how to run and use the codebase. | ||
| #### Examples | ||
|
|
||
| > [!IMPORTANT] Replace with examples demonstrating key functionality, code-snippets such as command-line usage, API calls or if needed screendumps | ||
| --- | ||
|
|
||
| [Jekyll]: https://jekyllrb.com | ||
| [Just the Docs]: https://just-the-docs.github.io/just-the-docs/ | ||
| [GitHub Pages]: https://docs.github.com/en/pages | ||
| [GitHub Pages / Actions workflow]: https://github.blog/changelog/2022-07-27-github-pages-custom-github-actions-workflows-beta/ | ||
| [Bundler]: https://bundler.io | ||
| [use this template]: https://github.com/just-the-docs/just-the-docs-template/generate | ||
| [`jekyll-default-layout`]: https://github.com/benbalter/jekyll-default-layout | ||
| [`jekyll-seo-tag`]: https://jekyll.github.io/jekyll-seo-tag | ||
| [MIT License]: https://en.wikipedia.org/wiki/MIT_License | ||
| [starter workflows]: https://github.com/actions/starter-workflows/blob/main/pages/jekyll.yml | ||
| [actions/starter-workflows]: https://github.com/actions/starter-workflows/blob/main/LICENSE | ||
| [^1]: [It can take up to 10 minutes for changes to your site to publish after you push the changes to GitHub](https://docs.github.com/en/pages/setting-up-a-github-pages-site-with-jekyll/creating-a-github-pages-site-with-jekyll#creating-your-site). | ||
| *This project is licensed under the terms of the [LICENSE.md](LICENSE.md) | For contribution guidelines, see [CONTRIBUTING.md](CONTRIBUTING.md) | Contact: [maintainer usernames]()* | ||
|
|
||
|
|