Skip to content

Commit f363c13

Browse files
committed
improved contriuting page
1 parent 8923508 commit f363c13

File tree

2 files changed

+13
-3
lines changed

2 files changed

+13
-3
lines changed

.gitignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22
Manifest.toml
33
docs/Manifest.toml
44

5+
# Mathematica (useful for translation of new rules)
6+
*.m
7+
58
# Documentation build artifacts
69
docs/build/
710

docs/src/manual/contributing.md

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,10 @@
1-
- [Contributing to improving RuleBasedMethod](#contributing-to-improving-rulebasedmethod)
1+
# Contributing
2+
3+
We welcome contributions!
4+
5+
Below there are detailed info on how to contribute to the translation of new rules from the Mathematica rules of the RUBI package.
6+
7+
- [Contributing to RuleBasedMethod](#contributing-to-rulebasedmethod)
28
- [Common problems when translating rules](#common-problems-when-translating-rules)
39
- [function not translated](#function-not-translated)
410
- [Sum function translation](#sum-function-translation)
@@ -13,7 +19,7 @@
1319
- [end](#end)
1420
- [Adding Testsuites](#adding-testsuites)
1521

16-
# Contributing to improving RuleBasedMethod
22+
# Contributing to translating new rules for RuleBasedMethod
1723

1824
In this repo there is also some software that serves the sole purpose of helping with the translation of rules from Mathematica syntax, and not for the actual package working. The important ones are:
1925
- translator_of_rules.jl is a script that with regex and other string manipulations translates from Mathematica syntax to julia syntax
@@ -75,10 +81,11 @@ This script is used to translate integration rules from Mathematica syntax
7581
to julia Syntax.
7682

7783
### How to use it
84+
It's handy to have the Mathematica files already in the correct folders in this repo (.m files are ignored by .gitignore), so that you can use the translator script like this:
7885
``` bash
7986
julia src/translator_of_rules.jl "src/rules/4 Trig functions/4.1 Sine/4.1.8 trig^m (a+b cos^p+c sin^q)^n.m"
8087
```
81-
and will produce the julia file at the path `src/rules/4 Trig functions/4.1 Sine/4.1.8 trig^m (a+b cos^p+c sin^q)^n.jl`
88+
this will produce the julia file at the path `src/rules/4 Trig functions/4.1 Sine/4.1.8 trig^m (a+b cos^p+c sin^q)^n.jl`
8289

8390
### How it works internally (useful to know if you have to debug it)
8491
It processes line per line, so the integration rule must be all on only one

0 commit comments

Comments
 (0)