Skip to content

Commit 1a1ad63

Browse files
authored
Merge pull request #13 from slel/patch-4
Rephrase some sentences, fix links and typos
2 parents 7bcbcd4 + 76d335f commit 1a1ad63

File tree

1 file changed

+63
-50
lines changed

1 file changed

+63
-50
lines changed

index.html

Lines changed: 63 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ <h2>Mathics is a free, open-source general-purpose computer
4949
in the Python ecosystem.
5050
</h2>
5151
<ul>
52-
<li> <a href="sept-21-status.html">Status as of Septemper 2021</a></li>
52+
<li> <a href="sept-21-status.html">Status as of September 2021</a></li>
5353
</ul>
5454
</header>
5555
</section>
@@ -59,23 +59,24 @@ <h2>Mathics is a free, open-source general-purpose computer
5959
<h2>Components</h2>
6060
<div class="inner align-left">
6161
<p>
62-
Mathics is broken up into a number of pieces in order to
63-
facilitate using the parts of you desire. This also
64-
reduces the vast number of dependencies to those that you
65-
need and the footprint to run.</p>
62+
Mathics has a modular design, allowing to reuse parts of it
63+
and run them with tailored dependencies and minimal footprint.
64+
</p>
6665

67-
<p>If you want to run everything, we have a docker container
68-
on <a href="https://hub.docker.com/r/mathicsorg/mathics">dockerhub</a>
69-
that has all of the components installed in the container.</p>
66+
<p>To run the full Mathics, a complete Docker image is available at
67+
<a href="https://hub.docker.com/r/mathicsorg/mathics">DockerHub</a>.
68+
</p>
7069

71-
<p>If you want to install everything locally without docker and have all the the necessary
72-
OS components there is the <a href="https://pypi.org/project/Mathics-omnibus/">PyPI Mathics omnibus package</a>.
70+
<p>To install everything locally without Docker, use the
71+
<a href="https://pypi.org/project/Mathics-omnibus/">Mathics-omnibus Python package</a>
72+
available from the Python package index.
73+
</p>
7374

74-
<p>The pieces are described next with the components' OS and
75-
Python-package dependencies.
75+
<p>The pieces that make up Mathics are described below, along with their
76+
dependencies, be they system package or Python package dependencies.
7677
</p>
7778

78-
<h3><a href="https://github.com/Mathics3/mathics-core">Mathics Core</a></h3>
79+
<h3>Mathics Core</h3>
7980

8081
<p>
8182
The Mathics core is required for any work with Mathics.
@@ -86,7 +87,13 @@ <h3><a href="https://github.com/Mathics3/mathics-core">Mathics Core</a></h3>
8687
Mathics, you may need no more than this.
8788
</p>
8889

89-
<h3 id="mathicsscript"><a href="https://pypi.org/project/mathics-django/">mathicsscript</a></h3>
90+
<ul>
91+
<li>
92+
Code repository: <a href="https://github.com/Mathics3/mathics-core">mathics-core on GitHub</a>
93+
<li>
94+
</ul>
95+
96+
<h3 id="mathicsscript">mathicsscript</h3>
9097
<p>
9198
mathicsscript is a fancier command-line client for Mathics.
9299
</p>
@@ -104,11 +111,12 @@ <h3 id="mathicsscript"><a href="https://pypi.org/project/mathics-django/">mathic
104111
</p>
105112

106113
<ul>
107-
<li><a href="https://python-prompt-toolkit.readthedocs.io/en/stable">prompt_toolkit</a>
108-
or GNU Readline terminal interaction. This includes
114+
<li>terminal interaction using either
115+
<a href="https://python-prompt-toolkit.readthedocs.io/en/stable">prompt_toolkit</a>
116+
or GNU Readline. This includes
109117

110118
<ul>
111-
<li>saving command history between sessions.</li>
119+
<li>saving command history between sessions</li>
112120

113121
<li>
114122
variable completion, even for symbol names like
@@ -123,31 +131,33 @@ <h3 id="mathicsscript"><a href="https://pypi.org/project/mathics-django/">mathic
123131
</li>
124132

125133
<li>
126-
Syntax highlighting using pygments.
134+
syntax highlighting using pygments
127135
</li>
128136

129137
<li>
130-
Automatic detection of light or dark terminal background color.
138+
automatic detection of light or dark terminal background color.
131139
</li>
132140

133141
<li>
134-
Entering and displaying Unicode symbols such as used for Pi or
142+
entering and displaying Unicode symbols such as used for Pi or
135143
Rule arrows
136144
</li>
137145
</ul>
138146

139-
<p>
140-
The mathicsscript is github respository is
141-
<a href="https://github.com/Mathics3/mathicsscript/">here</a>.
142-
</p>
147+
<ul>
148+
<li>
149+
Code repository: <a href="https://github.com/Mathics3/mathicsscript/">mathicsscript on GitHub</a>
150+
<li>
151+
<li>
152+
Python package: <a href="https://pypi.org/project/mathicsscript">mathicsscript on PyPI</a>
153+
<li>
154+
</ul>
143155

144-
<h3 id="django"><a href="https://pypi.org/project/mathics-django/">Mathics-Django</a></h3>
156+
<h3 id="django">Mathics-Django</h3>
145157

146158
<p>
147-
There is a browser-based webserver that has
148-
MathML-formatted formatted output using <a href="https://threejs.org/">three.js</a>
149-
graphics. The github repository is
150-
<a href="https://github.com/Mathics3/mathics-django">here</a>.
159+
This is a browser-based webserver with MathML-formatted output
160+
and <a href="https://threejs.org/">Three.js</a> graphics.
151161
</p>
152162

153163
<p>
@@ -162,16 +172,16 @@ <h3 id="django"><a href="https://pypi.org/project/mathics-django/">Mathics-Djang
162172

163173
<ul>
164174
<li>
165-
Extensive online documentation and interactive documentation via
175+
extensive online documentation and interactive documentation via
166176
Ajax
167177
</li>
168178

169179
<li>
170-
Integrated graphics and MathML mathematics output via MathJax and Three.js.
180+
integrated graphics and MathML mathematics output via MathJax and Three.js
171181
</li>
172182

173183
<li>
174-
Notebook-like sessions
184+
notebook-like sessions
175185
</li>
176186
</ul>
177187

@@ -180,6 +190,15 @@ <h3 id="django"><a href="https://pypi.org/project/mathics-django/">Mathics-Djang
180190
JavaScript enabled.
181191
</p>
182192

193+
<ul>
194+
<li>
195+
Code repository: <a href="https://github.com/Mathics3/mathics-django/">Mathics-Django on GitHub</a>
196+
<li>
197+
<li>
198+
Python package: <a href="https://pypi.org/project/mathics-django">Mathics-Django on PyPI</a>
199+
<li>
200+
</ul>
201+
183202
<p>
184203
For more information on how to install Mathics see
185204
<a href="https://mathics-development-guide.readthedocs.io/en/latest/installing.html">
@@ -228,14 +247,8 @@ <h2>Support</h2>
228247

229248
<li>
230249
Code repositories for all the components and website live
231-
under the
232-
<a href="https://github.com/mathics/">
233-
mathics
234-
</a>
235-
and the
236-
<a href="https://github.com/mathics3/">
237-
Mathics3
238-
</a>
250+
under the <a href="https://github.com/mathics/">mathics</a>
251+
and the <a href="https://github.com/Mathics3/">Mathics3</a>
239252
GitHub organizations.
240253
</li>
241254
</ul>
@@ -249,8 +262,8 @@ <h2>Contributing</h2>
249262
<p>
250263
Please check out our contributing guide at
251264
<a href="https://mathics-development-guide.readthedocs.io/en/latest/developing-code/contributing-developing.html">
252-
mathics-development-guide.readthedocs.io/en/latest/developing-code/contributing-developing
253-
</a>. <strong>Developers wanted! Please get in touch if you want
265+
mathics-development-guide.readthedocs.io/en/latest/developing-code/contributing-developing</a>.
266+
<strong>Developers wanted! Please get in touch if you want
254267
to be part of this awesome project.</strong>
255268
</p>
256269
</div>
@@ -265,13 +278,12 @@ <h2>Contributing</h2>
265278
</div>
266279
<div class="content">
267280
<h3>Free software</h3>
268-
<p> Mathics is licensed under
269-
<a
270-
href="https://github.com/Mathics3/mathics-core/blob/master/COPYING.txt"/>
271-
GPLv3</a> and is developed by an active community of
272-
volunteers. Its source code is freely available in the Github organizations
281+
<p> Mathics is licensed under the GNU General Public License
282+
<a href="https://github.com/Mathics3/mathics-core/blob/master/COPYING.txt">GPLv3</a>
283+
and is developed by an active community of
284+
volunteers. Its source code is freely available in repositories under the Github organizations
273285
<a href="https://github.com/mathics">Mathics</a> and
274-
<a href="https://github.com/Mathics3">Mathics3</a> repositories.
286+
<a href="https://github.com/Mathics3">Mathics3</a>.
275287
</p>
276288
</div>
277289
</section>
@@ -281,7 +293,8 @@ <h3>Free software</h3>
281293
</div>
282294
<div class="content">
283295
<h3>Python</h3>
284-
Since Mathics is a collection of Python packages. It is intended to be used as a collection or from other Python packages and code.
296+
As a collection of Python packages, Mathics is intended
297+
to be used as a whole or from other Python packages and code.
285298
</p>
286299
</div>
287300
</section>
@@ -305,7 +318,7 @@ <h2>On the Shoulders of Giants</h2>
305318
<li><a href="https://github.com/numba/llvmlite">llvmlite</a></li>
306319
<li><a href="https://www.djangoproject.com/">Django</a></li>
307320
<li><a href="https://www.mathjax.org/">MathJax</a></li>
308-
<li><a href="https://threejs.org/">three.js</a></li>
321+
<li><a href="https://threejs.org/">Three.js</a></li>
309322
<li><a href="https://asymptote.sourceforge.io/">Asymptote</a></li>
310323
<li><a href="https://SciPy.org/">SciPy</a> (which also includes a number of the above)</li>
311324
</ul>

0 commit comments

Comments
 (0)