Skip to content

Commit dad176f

Browse files
readme update
1 parent 3d8359e commit dad176f

File tree

3 files changed

+41
-12
lines changed

3 files changed

+41
-12
lines changed

README.html

+11-4
Original file line numberDiff line numberDiff line change
@@ -381,7 +381,8 @@ <h1 class="title">PySpice : Simulate Electronic Circuit using Python and the Ngs
381381
<!-- https://img.shields.io/github/stars/badges/shields.svg?style=social&label=Star -->
382382
<!-- End -->
383383
<!-- -*- Mode: rst -*- -->
384-
<p>Thanks to <a class="reference external" href="https://www.discourse.org">Discourse</a>, PySpice now has a Forum hosted at <a class="reference external" href="https://pyspice.discourse.group">https://pyspice.discourse.group</a></p>
384+
<p>Thanks to <a class="reference external" href="https://www.discourse.org">Discourse</a>, PySpice now has a <strong>Forum</strong> hosted at <a class="reference external" href="https://pyspice.discourse.group">https://pyspice.discourse.group</a></p>
385+
<p><strong>Disclaimer: PySpice is developed on my free time actually, so I could be busy with other tasks and less reactive.</strong></p>
385386
<p><a class="reference external" href="https://pypi.python.org/pypi/PySpice"><object data="https://img.shields.io/pypi/l/PySpice.svg" type="image/svg+xml">PySpice license</object></a>
386387
<a class="reference external" href="https://pypi.python.org/pypi/PySpice"><object data="https://img.shields.io/pypi/pyversions/PySpice.svg" type="image/svg+xml">PySpice python version</object></a></p>
387388
<p><a class="reference external" href="https://pypi.python.org/pypi/PySpice"><object data="https://img.shields.io/pypi/v/PySpice.svg" type="image/svg+xml">PySpice last version</object></a></p>
@@ -393,16 +394,16 @@ <h1 class="title">PySpice : Simulate Electronic Circuit using Python and the Ngs
393394
<h1>Overview</h1>
394395
<div class="section" id="what-is-pyspice">
395396
<h2>What is PySpice ?</h2>
396-
<p>PySpice is a Python module which interface <a class="reference external" href="http://python.org">Python</a> to the <a class="reference external" href="http://ngspice.sourceforge.net">Ngspice</a> and <a class="reference external" href="https://xyce.sandia.gov">Xyce</a> circuit
397-
simulators.</p>
397+
<p>PySpice is a Python module which interface <a class="reference external" href="http://python.org">Python</a> to the <a class="reference external" href="http://ngspice.sourceforge.net">Ngspice</a> and <a class="reference external" href="https://xyce.sandia.gov">Xyce</a> circuit simulators.</p>
398398
</div>
399399
<div class="section" id="where-is-the-documentation">
400400
<h2>Where is the Documentation ?</h2>
401401
<p>The documentation is available on the <a class="reference external" href="https://pyspice.fabrice-salvaire.fr">PySpice Home Page</a>.</p>
402+
<p><em>Note: This site is hosted on my own infrastructure, if the site seems done, please create an issue to notify me.</em></p>
402403
</div>
403404
<div class="section" id="where-to-get-help-or-talk-about-pyspice">
404405
<h2>Where to get help or talk about PySpice ?</h2>
405-
<p>Thanks to <a class="reference external" href="https://www.discourse.org">Discourse</a>, PySpice now has a Forum hosted at <a class="reference external" href="https://pyspice.discourse.group">https://pyspice.discourse.group</a></p>
406+
<p>Thanks to <a class="reference external" href="https://www.discourse.org">Discourse</a>, PySpice now has a <strong>Forum</strong> hosted at <a class="reference external" href="https://pyspice.discourse.group">https://pyspice.discourse.group</a></p>
406407
</div>
407408
<div class="section" id="what-are-the-main-features">
408409
<h2>What are the main features ?</h2>
@@ -426,6 +427,12 @@ <h2>How to install it ?</h2>
426427
<p>Look at the <a class="reference external" href="https://pyspice.fabrice-salvaire.fr/installation.html">installation</a> section in the documentation.</p>
427428
</div>
428429
</div>
430+
<div class="section" id="pull-request-recommendation">
431+
<h1>Pull Request Recommendation</h1>
432+
<p>To make it easier to merge your pull request, you should divide your PR into smaller and easier-to-verify units.</p>
433+
<p>Please do not make a pull requests with a lot of modifications which are difficult to check. <strong>If I merge
434+
pull requests blindly then there is a high risk this software will become a mess quickly for everybody.</strong></p>
435+
</div>
429436
<div class="section" id="credits">
430437
<h1>Credits</h1>
431438
<p>Authors: <a class="reference external" href="http://fabrice-salvaire.fr">Fabrice Salvaire</a></p>

README.rst

+15-4
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,9 @@
8888
PySpice : Simulate Electronic Circuit using Python and the Ngspice / Xyce Simulators
8989
=====================================================================================
9090

91-
Thanks to `Discourse <https://www.discourse.org>`_, PySpice now has a Forum hosted at https://pyspice.discourse.group
91+
Thanks to `Discourse <https://www.discourse.org>`_, PySpice now has a **Forum** hosted at https://pyspice.discourse.group
92+
93+
**Disclaimer: PySpice is developed on my free time actually, so I could be busy with other tasks and less reactive.**
9294

9395
|Pypi License|
9496
|Pypi Python Version|
@@ -104,18 +106,19 @@ Overview
104106
What is PySpice ?
105107
-----------------
106108

107-
PySpice is a Python module which interface |Python|_ to the |Ngspice|_ and |Xyce|_ circuit
108-
simulators.
109+
PySpice is a Python module which interface |Python|_ to the |Ngspice|_ and |Xyce|_ circuit simulators.
109110

110111
Where is the Documentation ?
111112
----------------------------
112113

113114
The documentation is available on the |PySpiceHomePage|_.
114115

116+
*Note: This site is hosted on my own infrastructure, if the site seems done, please create an issue to notify me.*
117+
115118
Where to get help or talk about PySpice ?
116119
-----------------------------------------
117120

118-
Thanks to `Discourse <https://www.discourse.org>`_, PySpice now has a Forum hosted at https://pyspice.discourse.group
121+
Thanks to `Discourse <https://www.discourse.org>`_, PySpice now has a **Forum** hosted at https://pyspice.discourse.group
119122

120123
What are the main features ?
121124
----------------------------
@@ -138,6 +141,14 @@ How to install it ?
138141

139142
Look at the `installation <https://pyspice.fabrice-salvaire.fr/installation.html>`_ section in the documentation.
140143

144+
Pull Request Recommendation
145+
===========================
146+
147+
To make it easier to merge your pull request, you should divide your PR into smaller and easier-to-verify units.
148+
149+
Please do not make a pull requests with a lot of modifications which are difficult to check. **If I merge
150+
pull requests blindly then there is a high risk this software will become a mess quickly for everybody.**
151+
141152
Credits
142153
=======
143154

README.txt

+15-4
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,9 @@
77
PySpice : Simulate Electronic Circuit using Python and the Ngspice / Xyce Simulators
88
=====================================================================================
99

10-
Thanks to `Discourse <https://www.discourse.org>`_, PySpice now has a Forum hosted at https://pyspice.discourse.group
10+
Thanks to `Discourse <https://www.discourse.org>`_, PySpice now has a **Forum** hosted at https://pyspice.discourse.group
11+
12+
**Disclaimer: PySpice is developed on my free time actually, so I could be busy with other tasks and less reactive.**
1113

1214
|Pypi License|
1315
|Pypi Python Version|
@@ -23,18 +25,19 @@ Overview
2325
What is PySpice ?
2426
-----------------
2527

26-
PySpice is a Python module which interface |Python|_ to the |Ngspice|_ and |Xyce|_ circuit
27-
simulators.
28+
PySpice is a Python module which interface |Python|_ to the |Ngspice|_ and |Xyce|_ circuit simulators.
2829

2930
Where is the Documentation ?
3031
----------------------------
3132

3233
The documentation is available on the |PySpiceHomePage|_.
3334

35+
*Note: This site is hosted on my own infrastructure, if the site seems done, please create an issue to notify me.*
36+
3437
Where to get help or talk about PySpice ?
3538
-----------------------------------------
3639

37-
Thanks to `Discourse <https://www.discourse.org>`_, PySpice now has a Forum hosted at https://pyspice.discourse.group
40+
Thanks to `Discourse <https://www.discourse.org>`_, PySpice now has a **Forum** hosted at https://pyspice.discourse.group
3841

3942
What are the main features ?
4043
----------------------------
@@ -57,6 +60,14 @@ How to install it ?
5760

5861
Look at the `installation <https://pyspice.fabrice-salvaire.fr/installation.html>`_ section in the documentation.
5962

63+
Pull Request Recommendation
64+
===========================
65+
66+
To make it easier to merge your pull request, you should divide your PR into smaller and easier-to-verify units.
67+
68+
Please do not make a pull requests with a lot of modifications which are difficult to check. **If I merge
69+
pull requests blindly then there is a high risk this software will become a mess quickly for everybody.**
70+
6071
Credits
6172
=======
6273

0 commit comments

Comments
 (0)