rwf2
/
Rocket
mirror of https://github.com/rwf2/Rocket.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Remove duplication in site README.

This commit is contained in:
Sergio Benitez 2017-04-16 21:28:36 -07:00
parent b5ef6ec85b
commit 90c6636821
1 changed files with 6 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
site/README.md
View File

@ -10,20 +10,18 @@ This directory contains the following:
* `index.toml` - Source data for the index (`/`).
* `news.toml` - Source data for the news page (`/news`).
* `overview.toml` - Source data for the overview page (`/overview`).
* `guide.md` - Index page for the guide (`/guide`).
* `guide.md` - Index page for the [Rocket Programming Guide] (`/guide`).
* `news/*.md` - News articles linked to from `news.toml`.
* `guide/*.md` - Guide pages linked to from `guide.md`.
## Guide
[Rocket Programming Guide]: https://rocket.rs/guide/
The source files for the [Rocket Programming Guide](https://rocket.rs/guide/)
can be found in the `guide/` directory. One exception is the root of the guide,
which is `guide.md`.
### Guide Links
Cross-linking to pages in the guide is accomplished via absolute links rooted at
`/guide/`. To link to the page whose source is at `guide/page.md` in this
directory, for instance, link to `/guide/page`.
`/guide/`. To link to the page whose source is at `guide/page.md`, for instance,
link to `/guide/page`.
# License
## License
The Rocket website source is licensed under the [GNU General Public License v3.0](LICENSE).