Mercurial > web-octave

comparison README.md @ 211:a3ad764ca547

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
* README.md: Update developer description.
author Kai T. Ohlhus <k.ohlhus@gmail.com>
date Fri, 10 Jul 2020 00:41:14 +0900
parents ff5b4e46fe3d
children 0c24e49c860f
comparison
equal deleted inserted replaced
210:d402a202c57e 211:a3ad764ca547
20 20
21 ## Development 21 ## Development
22 22
23 ### Getting the sources 23 ### Getting the sources
24 24
25 Anyone is free to clone this development repository, simply type 25 Anyone is free to clone this website development repository, simply type
26 26
27 hg clone https://hg.octave.org/web-octave 27 hg clone https://hg.octave.org/web-octave
28 28
29 to get anonymous read access without writing privileges. 29 to get anonymous read access without writing privileges.
30 To push your changes, please contact the octave developers at 30 To push your changes, please contact the octave developers at
31 `maintainers@octave.org`. 31 https://octave.discourse.group/.
32 32
33 If you already have writing permissions for this repository, 33 If you already have writing permissions for this repository,
34 you should clone the repository using 34 you should clone the repository using
35 35
36 hg clone ssh://gnuoctave@octave.org/hg/web-octave 36 hg clone ssh://gnuoctave@octave.org/hg/web-octave
52 52
53 bundle install 53 bundle install
54 54
55 from within the checked-out [hg development repository][2]. 55 from within the checked-out [hg development repository][2].
56 56
57 For the responsive webpages, we internally use the [Foundation 5][8] 57 For the responsive webpages, we internally use the [Foundation 6][8]
58 framework. All necessary files are already included inside the 58 framework. All necessary files are already included inside this
59 [hg development repository][2]. 59 [hg development repository][2].
60 60
61 [6]: https://www.ruby-lang.org/ 61 [6]: https://www.ruby-lang.org/
62 [7]: https://bundler.io/ 62 [7]: https://bundler.io/
63 [8]: https://foundation.zurb.com/sites/docs/v/5.5.3/ 63 [8]: https://get.foundation/sites/docs/
64 64
65 65
66 66
67 ### Building the static website locally 67 ### Building the static website locally
68 68
69 All relevant information for Bundler to build the static website are located in 69 All relevant information for Bundler to build the static website are located in
70 the files `_config.yml`, `Gemfile`, and `Gemfile.lock`. Typing 70 the files `_config.yml`, `Gemfile`, and `Gemfile.lock`. Typing
71 71
72 bundle exec jekyll build 72 bundle exec jekyll build
73 73
74 from the repositories root directory will build a complete static website 74 from the repository root directory will build a complete static website
75 into the subdirectory `_site` using this information (this directory is 75 into the subdirectory `_site` using this information. This directory is
76 ignored by Mercurial and will be created on first build). 76 ignored by Mercurial and will be created on first build.
77 77
78 Especially for development, it is beneficial to watch the changes locally 78 Especially for development, it is beneficial to watch the changes locally
79 before pushing any changes. Jekyll provides a local webserver by typing 79 before pushing any changes. Jekyll provides a local webserver by typing
80 80
81 bundle exec jekyll serve 81 bundle exec jekyll serve
91 especially the date. 91 especially the date.
92 92
93 **Be sure to choose the correct categories!!** 93 **Be sure to choose the correct categories!!**
94 94
95 `categories: news release` is reserved for release announcements, those posts 95 `categories: news release` is reserved for release announcements, those posts
96 are also displayed inside the GUI. Consider choosing another category like 96 are also displayed inside the Octave GUI. Consider choosing another category
97 `categories: news` or alike for less important news. 97 like `categories: news` or alike for less important news.
98 98
99 99
100 100
101 ### Deploying the static website online 101 ### Deploying the static website online
102 102