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