Commits

Pierre Pagnoux  committed b45ebec

Doc

  • Participants
  • Parent commits dccc7d3

Comments (0)

Files changed (2)

File doc/doc/gui.md

 
 \begin{figure}[!h!]
 \centering
-\includegraphics[scale=0.40]{../img/gui3_settings.png}
-\caption{Interface graphique finale avec fenêtres de réglages}
+\includegraphics[scale=0.35]{../img/gui3_settings.png}
 \end{figure}
 
 To know more about us, the project and the website go to the *About* menu and click on *About us*.\newline
 
 To open a file just click on the *File* menu and then on *Open*, a standard window will appear.\newline
 
-## Adding /& setting effects
+## Adding \& setting effects
 
-Once your file is open you can add one or several effects by clicking on the assciated buttons. Their names will appear in the list on the right. Clicking on a button will also open an associated setting window. You can move the cursors to make your own settings.\newline
+Once your file is open you can add one or several effects by clicking on the associated buttons. Their names will appear in the list on the right. Clicking on a button will also open an associated setting window. You can move the cursors to make your own settings.\newline
 
 
 ## Remove one or several effects

File doc/doc/instr.md

-# Dependency
+# Dependencies
+
+## StarDSP
+Make sure dependencies are installed :
+
+* OCaml 3.12
+* LablGTK2
+* PulseAudio
+* LibSndFile
+* Mara ($\geq 13$)
+
+## Documentation
+
+* \LaTeX
+* Pandoc
 
 # Compilation
 
-# Usage
+## PulseAudio Simple API
+
+First of all, you will need to install our *OCaml* binding for *PulseAudio Simple API*.
+
+	$ cd path/to/stardsp/lib
+	$ make
+	# make install
+
+## Installation of StarDSP
+
+Then you can compile StarDSP — in the `src` folder — and run it :
+
+	$ make
+	$ ./stardsp
+	
+If you want to use it permanently, install it :
+
+	# make install
+# Usage
+
+\begin{verbatim}
+$ ./stardsp —help
+Usage : ./stardsp [OPTIONS]
+Input : Realtime or AIFF
+	-core						Run core only
+	-file <path>				AIFF file input
+	-surface <device>			TTY
+	-ssurface <data>			test Control-surface
+	-eq <lg,mg,hg>				Use Equalizer
+	-amp <drive,noise>			Use Amplifier
+	-rev <modulation>			Use Reverberation
+	-echo <delay,decay>			Use Echo
+	-stereo <modulation>		Use Stereo effect
+	-balance <left/right>		Stereo Balance
+	-default					Surface preset
+\end{verbatim}
+
+ There are three different ways to use StarDSP :
+ 
+ * The core only
+ * The surface
+ * The GUI
+
+The command line interface takes into account the order of effect adding.