File tree Expand file tree Collapse file tree 2 files changed +46
-0
lines changed Expand file tree Collapse file tree 2 files changed +46
-0
lines changed Original file line number Diff line number Diff line change 1+ ISC License (ISC)
2+
3+ Copyright (c) 2016, Serenity Contributors
4+
5+ Permission to use, copy, modify, and/or distribute this software for any purpose
6+ with or without fee is hereby granted, provided that the above copyright notice
7+ and this permission notice appear in all copies.
8+
9+ THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
10+ REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
11+ FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
12+ INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS
13+ OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
14+ TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF
15+ THIS SOFTWARE.
Original file line number Diff line number Diff line change 1+ # Site source code
2+
3+ This is source code for the https://serenity-rs.github.io site, built using
4+ Vite.
5+
6+ ## Contributing
7+
8+ If you wish to contribute, simply set up a [ Node.js] [ node ] environment with the
9+ NPM package manager.
10+
11+ Once you have Node and NPM, install the necessary dependencies with ` npm install ` .
12+
13+ Afterwards, you may use ` npm run dev ` to run a dev server to test changes
14+ locally, which will run on ` localhost:3000 ` . Once you are satisfied with the
15+ changes, run ` npm run build ` to build the site. This will create a minified,
16+ bundled version of the site into the ` docs/ ` directory, which can directly be
17+ served by a HTTP server like [ Nginx] [ nginx ] , though, of course, this site is
18+ meant to be run on Github Pages.
19+
20+ This site uses [ TypeScript] [ ts ] and [ SCSS] [ sass-scss ] instead of regular
21+ JavaScript and CSS. When writing CSS, the [ RSCSS] [ rscss ] system is used.
22+
23+ [ node ] : https://nodejs.org
24+ [ nginx ] : https://nginx.org
25+ [ ts ] : https://typescriptlang.org
26+ [ sass-scss ] : https://sasscss.com
27+ [ rscss ] : https://rstacruz.github.io/rscss/
28+
29+ ## License
30+
31+ Source code of this site is under the [ ISC license] ( LICENSE.md ) .
You can’t perform that action at this time.
0 commit comments