diff --git a/README.md b/README.md index e1a1ec045c41f6c89f527dc62d15916e7eb5101b..ea942145ec8abfeca19d4b002bd6daee3324ef86 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,6 @@ A unique, online mentorship programme conceptualized and organized by Free Softw Free Software Camp is a mentorship programme for bringing more people to Free Software with strong focus on philosophy. We connect learners with experienced Free Software community members to work on some tasks together - this could be either technical or non technical. This repo contains the website and resources related to Free Software Camp. -- **website** : This folder consists the source code of the camp.fsf.org.in website. Instructions to develop and build the website is given in the README.md file in the website folder. +- **website** : This folder consists the source code of the camp.fsf.org.in website. Instructions to develop and build the website is given in the [README.md](website/README.md) file in the website folder. - **poster** : Consists of Promotional for Free Software Camp - **scripts** : Consist of some useful Scripts diff --git a/website/README.md b/website/README.md index d0f138068f3af93d0a7964f3d4c45825662ac712..4ab59fcad6f1c9804dd19930074fed13e9c273f1 100644 --- a/website/README.md +++ b/website/README.md @@ -3,7 +3,7 @@ This website is build using [Hugo](https://gohugo.io/ "Hugo website"), a static site generator built with Go. ### Installing Hugo -Hugo is available on most modern operating systems. If you're using a GNU/Linux distribution that uses the `apt` package manager (Debian, Ubuntu or any of their derivatives) you can install it with the following command: +Hugo is available on most modern operating systems. If you're using a GNU/Linux distribution that uses the `apt` package manager (Debian, Ubuntu or any of their derivatives) you can install it with the following command: ``` sh sudo apt install hugo @@ -33,8 +33,20 @@ hugo server -D --buildDrafts To generate static websites, just run the command `hugo` from the command line from the project's root folder where the config.toml file is present. This will generate the files in a directory called `public`. These files can now be deployed using a web server of your choice. +### To add a news/announcement: + +Run `hugo new news/title-of-the-new-statement.md`. + +A new markdown file will be created under content/news/ directory. Use your favourite text editor to edit it. + +To see website preview, run `hugo server -D`. + +Open `localhost:1313` in your browser. + +When you finish drafting the news item, to make it live, change `draft: true` to `draft: false` in the above created markdown file. + ### Workflow for camp.fsf.org.in - Make necessary changes and commit the changes to git. -- Run the `generate-site` script (present in the Scripts folder in the root folder) from the website folder. +- Run the `generate-site` script (present in the Scripts folder in the root folder) from the website folder. - Switch to the `production` branch. - Run the `update` script, commit the changes in git and push the changes to production branch.