diff options
| author | HampusM <hampus@hampusmat.com> | 2021-08-12 15:37:30 +0200 |
|---|---|---|
| committer | HampusM <hampus@hampusmat.com> | 2021-08-12 15:37:30 +0200 |
| commit | d41b27f43335cfb1a8ff49aeb121f992332429cf (patch) | |
| tree | 93b6e1ec9b292c3d80ee1a538d0e729612148052 /docs_src | |
| parent | 30f0b2ee1f494be1786280040fb47ec18bde8a6d (diff) | |
Cleaned up the settings implementation & renamed base_dir project-wide to git_dir
Diffstat (limited to 'docs_src')
| -rw-r--r-- | docs_src/hacking.md | 8 | ||||
| -rw-r--r-- | docs_src/installation.md | 16 |
2 files changed, 16 insertions, 8 deletions
diff --git a/docs_src/hacking.md b/docs_src/hacking.md index 81a806c..518477b 100644 --- a/docs_src/hacking.md +++ b/docs_src/hacking.md @@ -14,6 +14,14 @@ This package contains interfaces and types shared by the server and client packa ### Eslint-config-base This package contains a base Eslint configuration for the server and client packages. Aswell as for the test environment. +## Important notes +You may want to add the following to your settings.json +``` +"dev": { + "port": (Port for the Vue.js development server) +} +``` + ## Development utilities You can use the following command to run a live-updating instance of Githermit. diff --git a/docs_src/installation.md b/docs_src/installation.md index 723d35e..f19c4e0 100644 --- a/docs_src/installation.md +++ b/docs_src/installation.md @@ -28,15 +28,15 @@ And finally, build the project. `$ yarn build` -The final step is to create a file called `settings.yml` with the following content. +The final step is to create a file called `settings.json` with the following content. ``` -host: (Host address) -port: (Port) -dev_port: (Port for development server) -production: (Set this to true unless you're doing changes to Githermit) -title: (Title of your Githermit instance) -about: (Short description of your Githermit instance) -base_dir: (Directory where all of your bare Git repositories are located) +{ + "host": "(Host address)", + "port": (Port), + "title": "(Title of your Githermit instance)", + "about": "(Short description of your Githermit instance)", + "git_dir: "(Directory where all of your bare Git repositories are located)" +} ``` ## Starting |