##// END OF EJS Templates
Improved README
Jeandet Alexis -
r29:69358cdc8faa default
parent child
Show More
@@ -1,76 +1,76
1 1 SocExplorer
2 2 -----------
3 3
4 4 SocExplorer is an open source generic System On Chip testing software/framework.
5 5 We write this software for the development and the validation of our instrument,
6 6 the Low Frequency Receiver(LFR) for the Solar Orbiter mission. This instrument is
7 7 based on an actel FPGA hosting a LEON3FT processor and some peripherals. To
8 8 make it more collaborative, we use a plugin based system, the main executable is
9 9 SocExplorer then all the functionality are provided by plugins. Like this
10 10 everybody can provide his set of plugins to handle a new SOC or just a new
11 11 peripheral. SocExplorer uses PythonQt to allow user to automate some tasks such
12 12 as loading some plugins, configuring them and talking with his device.
13 13
14 14 Licensing
15 15 ---------
16 16
17 17 SocExplorer is provided under the terms of the GNU General Public License as published by the
18 18 Free Software Foundation; either version 2 of the License, or (at your option) any
19 19 later version.
20 20
21 21 Wiki
22 22 ----
23 23
24 More details here https://hephaistos.lpp.polytechnique.fr/redmine/projects/socexplorer/wiki
24 More details [here](https://hephaistos.lpp.polytechnique.fr/redmine/projects/socexplorer/wiki)
25 25
26 26 How to build
27 27 ------------
28 28
29 29 To build it on linux you can look here https://hephaistos.lpp.polytechnique.fr/redmine/projects/socexplorer/wiki/Linux_setup
30 30
31 31 If you can't access to it, first you will need a working qt5 kit with all the development packages.
32 32 Step 1:
33 33 You need to get a modified version of PythonQt, you can clone it from our repository
34 34 ```Bash
35 35 hg clone https://hephaistos.lpp.polytechnique.fr/rhodecode/HG_REPOSITORIES/LPP/INSTRUMENTATION/USERS/JEANDET/PythonQt PythonQt
36 36 cd PythonQt
37 37 qmake-qt5
38 38 make
39 39 sudo make install
40 40 ```
41 41 Step 2:
42 42 Get and install SocExplorer
43 43 ```Bash
44 44 hg clone https://hephaistos.lpp.polytechnique.fr/rhodecode/HG_REPOSITORIES/LPP/INSTRUMENTATION/SocExplorer SocExplorer
45 45 cd SocExplorer
46 46 qmake-qt5
47 47 make
48 48 sudo make install
49 49 mkdir -p ~/.SocExplorer/config
50 50 cp ressources/Grlib.xml ~/.SocExplorer/config/Grlib.xml
51 51 ```
52 52 Step 3:
53 53 Get and install SocExplorer main plugins
54 54 ```Bash
55 55 hg clone https://hephaistos.lpp.polytechnique.fr/rhodecode/HG_REPOSITORIES/LPP/INSTRUMENTATION/SocExplorerPlugins SocExplorerPlugins
56 56 qmake-qt5
57 57 make
58 58 make install # /!\ As regular user!
59 59 ```
60 60
61 61 Bug repports
62 62 ------------
63 63
64 To repport any bug you can either send a mail at alexis.jeandet@member.fsf.org or repport an issue here https://hephaistos.lpp.polytechnique.fr/redmine/projects/socexplorer/issues
64 To repport any bug you can either send a [mail](mailto:alexis.jeandet@member.fsf.org) or repport an issue [here](https://hephaistos.lpp.polytechnique.fr/redmine/projects/socexplorer/issues)
65 65
66 66
67 67
68 68
69 69
70 70
71 71
72 72
73 73
74 74
75 75
76 76
General Comments 0
You need to be logged in to leave comments. Login now