Mercurial > web-octave

comparison README.md @ 183:ff5b4e46fe3d

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Update build information.
author Kai T. Ohlhus <k.ohlhus@gmail.com>
date Wed, 08 Jul 2020 11:08:19 +0900
parents 7a664b44fd8d
children a3ad764ca547
comparison
equal deleted inserted replaced
182:7a664b44fd8d 183:ff5b4e46fe3d
10 3. After deploying the static pages, they are visible from 10 3. After deploying the static pages, they are visible from
11 [https://www.octave.org][1], that redirects to 11 [https://www.octave.org][1], that redirects to
12 [https://www.gnu.org/software/octave][4]. 12 [https://www.gnu.org/software/octave][4].
13 13
14 [1]: https://www.octave.org 14 [1]: https://www.octave.org
15 [2]: http://hg.octave.org/web-octave 15 [2]: https://hg.octave.org/web-octave
16 [3]: https://web.cvs.savannah.gnu.org/viewvc/octave/?root=octave 16 [3]: https://web.cvs.savannah.gnu.org/viewvc/octave/?root=octave
17 [4]: https://www.gnu.org/software/octave 17 [4]: https://www.gnu.org/software/octave
18 18
19 19
20 20
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 development repository, simply type
26 26
27 hg clone http://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 `maintainers@octave.org`.
32 32
37 37
38 38
39 39
40 ### Building requisites 40 ### Building requisites
41 41
42 To build the static website, you need to install [Jekyll][6] and [Bundler][7]. 42 To build the static website, you need to install [Ruby][6] and [Bundler][7].
43 For Debian/Ubuntu please perform the following setup fist. For other Linux 43 For Debian/Ubuntu please perform the following setup fist. For other Linux
44 distributions this command might change. 44 distributions this command might change.
45 45
46 sudo apt-get install ruby-full build-essential zlib1g-dev 46 sudo apt-get install ruby-full build-essential zlib1g-dev
47 47
48 Then install the required tools 48 gem install bundler
49 49
50 gem install jekyll bundler 50 From now on, everything is handled by Bundler. Install all required
51
52 From now on, almost everything is handled by Bundler. Install all required
53 dependencies for the static Octave website by running 51 dependencies for the static Octave website by running
54 52
55 bundle install 53 bundle install
56 54
57 from within the checked-out [hg development repository][2]. 55 from within the checked-out [hg development repository][2].
58 56
59 For the responsive webpages, we internally use the [Foundation 5][8] 57 For the responsive webpages, we internally use the [Foundation 5][8]
60 framework. All necessary files are already included inside the 58 framework. All necessary files are already included inside the
61 [hg development repository][2]. 59 [hg development repository][2].
62 60
63 [6]: https://jekyllrb.com/ 61 [6]: https://www.ruby-lang.org/
64 [7]: https://bundler.io/ 62 [7]: https://bundler.io/
65 [8]: https://foundation.zurb.com/sites/docs/v/5.5.3/ 63 [8]: https://foundation.zurb.com/sites/docs/v/5.5.3/
66 64
67 65
68 66
69 ### Building the static website locally 67 ### Building the static website locally
70 68
71 All relevant information for Jekyll and Bundler to build the static website are 69 All relevant information for Bundler to build the static website are located in
72 located in the files `_config.yml`, `Gemfile`, and `Gemfile.lock`. 70 the files `_config.yml`, `Gemfile`, and `Gemfile.lock`. Typing
73 Typing
74 71
75 bundle exec jekyll build 72 bundle exec jekyll build
76 73
77 from the repositories root directory will build a complete static website 74 from the repositories root directory will build a complete static website
78 into the subdirectory `_site` using this information (this directory is 75 into the subdirectory `_site` using this information (this directory is