unimore/triennale-appunti-steffo
unimore/triennale-appunti-steffo
1
Fork 0
mirror of https://github.com/Steffo99/unisteffo.git synced 2024-11-24 00:44:20 +00:00
Code Activity

Update README

Browse source
This commit is contained in:
Steffo 2022-06-29 10:23:00 +02:00
parent fc555c5c3b
commit b7c4fa05ee
Signed by: steffo
GPG key ID: 6965406171929D01
2 changed files with 29 additions and 26 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

26
CONTRIBUTING.md Normal file
View file

@ -0,0 +1,26 @@
# Contributing
All contributions are welcome!
Please help me making this an useful resource to all students everywhere, and correct mistakes if you find them! :D
## Developing
### Running a local copy
If you want to run a local copy of the website, ensure [the latest `nodejs`](https://nodejs.org/it/) and `npm` are installed on your machine then run:
```bash
git clone https://github.com/Steffo99/appuntiweb-omega.git
cd appuntiweb-omega
yarn install
yarn run dev
```
### Updating the website
To update the published website, just push the commit to the `main` branch.
[Vercel](https://vercel.com/) will do the rest.
Pull Requests are previewed through Vercel as well: when the deploy is complete, a bot will comment with the preview link.

29
README.md
View file

@ -1,30 +1,7 @@
# Unisteffo + Appuntiweb
A website containing the material I made to prepare for university exams!
_A website containing the material I made to prepare for university exams, third edition_
## Contributing
(Unisteffo is the website, Appuntiweb is the software)
All contributions are welcome!
Please help me making this an useful resource to all students everywhere, and correct mistakes if you find them! :D
## Developing
### Running a local copy
If you want to run a local copy of the website, ensure [the latest `nodejs`](https://nodejs.org/it/) and `npm` are installed on your machine then run:
```bash
git clone https://github.com/Steffo99/appuntiweb.git
cd appuntiweb
yarn install
yarn run dev
```
### Updating the website
To update the published website, just push the commit to the `main` branch.
[Vercel](https://vercel.com/) will do the rest.
Pull Requests are previewed through Vercel as well: when the deploy is complete, a bot will comment with the preview link.
\[ [**Website**](https://uni.steffo.eu/) | [Contributing](CONTRIBUTING.md) \]