nick/whenwe2
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Compare commits

base: nick:5f66fbc040a4f76644cfe44a395d62c38dfae426
Branches Tags
nick:master nick:ghost-import
..
compare: nick:5e8be866b4b53522da6f14cb82b298198c0cf306
Branches Tags
nick:ghost-import nick:master

2 Commits
5f66fbc040 ... 5e8be866b4

Author SHA1 Message Date
Nick Stokoe
5e8be866b4 src/README.md - brief intro for this folder 2023-05-09 21:22:40 +01:00
Nick Stokoe
03b73cbae5 README.md - first draft 2023-05-09 21:22:40 +01:00
1 changed files with 4 additions and 3 deletions
Expand all files Collapse all files

7
README.md
View File

@@ -15,7 +15,7 @@ Everything in the top directory are configs and documentation, like this.
## Requirements ## Requirements
The site is built using Eleventy. We assume you have Git, NodeJS and NPM installed. The site is built using [Eleventy][eleventy]. We assume you have Git, NodeJS and NPM installed.
## Installation for development or deployment ## Installation for development or deployment
@@ -29,7 +29,7 @@ The site is built using Eleventy. We assume you have Git, NodeJS and NPM install
Now you should be able to visit the development site in your browser at http://localhost:8080 Now you should be able to visit the development site in your browser at http://localhost:8080
If you edit the content in src/ - it should rebuild the site. Your browser should refresh automatically, but if not, refresh it manually. If you edit the content in `src/` - it should rebuild the site. Your browser should refresh automatically, but if not, refresh it manually.
See the [README.md](./src/) in `src/` for more information. See the [README.md](./src/) in `src/` for more information.
@@ -39,7 +39,7 @@ Currently the destination is configured in package.json, as part of the definiti
`rsync` is used for deploying the site. Therefore you need to have that installed and on the path. `rsync` is used for deploying the site. Therefore you need to have that installed and on the path.
You will need `ssh` access to the destination. Setting that up is outside the scope of this document, but if you have your own web space, you will probably know about this already, and if not, you will need the assistance of someone who does. For setting up your ssh client, it depends on your OS - there are guides online. You will need `ssh` access to the destination. Setting that up is outside the scope of this document, but if you have your own web space, you will probably know about this already, and if not, you will need the assistance of someone who does. Setting up your ssh client depends on your OS - there are guides online.
But given that, the deploy process goes like this: But given that, the deploy process goes like this:
@@ -50,3 +50,4 @@ But given that, the deploy process goes like this:
These can be submitted via the issue tracker attached to this repository. You may need to create an account. These can be submitted via the issue tracker attached to this repository. You may need to create an account.
[eleventy]: https://www.11ty.dev/