Skip to content

Commit

Permalink
help updated
Browse files Browse the repository at this point in the history
  • Loading branch information
seub committed Nov 12, 2012
1 parent 0f6b4a0 commit 0098d1f
Show file tree
Hide file tree
Showing 3 changed files with 27 additions and 21 deletions.
4 changes: 2 additions & 2 deletions CirclePackings.pro.user
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE QtCreatorProject>
<!-- Written by Qt Creator 2.5.2, 2012-10-28T14:43:20. -->
<!-- Written by Qt Creator 2.5.2, 2012-11-12T23:54:34. -->
<qtcreator>
<data>
<variable>ProjectExplorer.Project.ActiveTarget</variable>
Expand Down Expand Up @@ -76,7 +76,7 @@
<value type="QString" key="ProjectExplorer.ProjectConfiguration.DisplayName"></value>
<value type="QString" key="ProjectExplorer.ProjectConfiguration.Id">Qt4ProjectManager.MakeStep</value>
<value type="bool" key="Qt4ProjectManager.MakeStep.Clean">false</value>
<value type="QString" key="Qt4ProjectManager.MakeStep.MakeArguments">-j8</value>
<value type="QString" key="Qt4ProjectManager.MakeStep.MakeArguments">-j 8</value>
<value type="QString" key="Qt4ProjectManager.MakeStep.MakeCommand"></value>
</valuemap>
<value type="int" key="ProjectExplorer.BuildStepList.StepsCount">2</value>
Expand Down
21 changes: 12 additions & 9 deletions doc/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -196,19 +196,22 @@ <h3> Linux (or UNIX) users: </h3>
the sources. Note that installing the package will only work on Debian-based distributions (Debian, Ubuntu, Mint...). </p>

<h4> Install the package (Debian-based distributions): </h4>
<p> Download and install <a href="https://github.com/downloads/seub/CirclePackings/CirclePackings-32.deb">this package</a>
<p> Download and install <a href="https://github.com/downloads/seub/CirclePackings/circlepackings_1.0_i386.deb">this package</a>
(32 bits, works on all systems but is slower)
or <a href="https://github.com/downloads/seub/CirclePackings/CirclePackings-64.deb">this package</a> (64 bits systems only). </p>
or <a href="https://github.com/downloads/seub/CirclePackings/circlepackings_1.0_amd64.deb">this package</a> (64 bits systems only). </p>

<p> Installing the package can be done by
opening a terminal, stepping into the folder containing the package (using <em>cd</em>) and typing:
<p> To install the package, you may use your favorite package manager (such as Logitech on Ubuntu), usually
just double-clicking on the deb file will do. This should automatically install the dependencies.</p>

<p> Alternatively, you may open a terminal,
step into the folder containing the package (using <em>cd</em>) and type:
<div class= "code">
sudo dpkg -i CirclePackings-32.deb
</div> </p>
<p> You will be prompted to install <strong>libqt4-dev</strong> if not already installed on your system.
sudo dpkg -i <em>&lt;name of the deb file&gt;</em>
</div></p>
<p> You will be prompted to install a certain number of dependencies (libraries) if they are not already installed on your system.
This can be done by typing:
<div class= "code">
sudo apt-get install libqt4-dev
sudo apt-get install libc6 libgcc1 libqtcore4 libqtgui4 libstdc++6
</div></p>

<h4> Compile from the sources: </h4>
Expand All @@ -235,7 +238,7 @@ <h4> Compile from the sources: </h4>
<span class = "in_code"> ./CirclePackings</span></li>
<li> Creating a shortcut, setting the application's icon, etc: I'm afraid that's out of our scope. You need to find out how to do this on your system
by yourself. For example, you can use <a href="http://xiaonosekai.wordpress.com/2012/06/16/how-to-create-launcher-for-the-dash-of-unity/">this guide</a>
for Ubuntu with unity. </ol>
for Ubuntu with Unity. </ol>


<h1 id="getting_started"> Getting Started </h1>
Expand Down
23 changes: 13 additions & 10 deletions doc/index.html~
Original file line number Diff line number Diff line change
Expand Up @@ -196,19 +196,22 @@
the sources. Note that installing the package will only work on Debian-based distributions (Debian, Ubuntu, Mint...). </p>

<h4> Install the package (Debian-based distributions): </h4>
<p> Download and install <a href="https://github.com/downloads/seub/CirclePackings/CirclePackings-32.deb">this package</a>
<p> Download and install <a href="https://github.com/downloads/seub/CirclePackings/circlepackings_1.0_i386.deb">this package</a>
(32 bits, works on all systems but is slower)
or <a href="https://github.com/downloads/seub/CirclePackings/CirclePackings-64.deb">this package</a> (64 bits systems only). </p>
or <a href="https://github.com/downloads/seub/CirclePackings/circlepackings_1.0_amd64.deb">this package</a> (64 bits systems only). </p>

<p> Installing the package can be done by
opening a terminal, stepping into the folder containing the package (using <em>cd</em>) and typing:
<p> To install the package, you may use your favorite package manager (such as Logitech on Ubuntu), usually
just double-clicking on the deb file will do. This should automatically install the dependencies.</p>

<p> Alternatively, you may open a terminal,
step into the folder containing the package (using <em>cd</em>) and type:
<div class= "code">
sudo dpkg -i CirclePackings-32.deb
</div> </p>
<p> You will be prompted to install <strong>libqt4-dev</strong> if not already installed on your system.
sudo dpkg -i <em>&lt;name of the deb file&gt;</em>
</div></p>
<p> You will be prompted to install a certain number of dependencies (libraries) if they are not already installed on your system.
This can be done by typing:
<div class= "code">
sudo apt-get install libqt4-dev
sudo apt-get install libc6 libgcc1 libqtcore4 libqtgui4 libstdc++6
</div></p>

<h4> Compile from the sources: </h4>
Expand Down Expand Up @@ -458,8 +461,8 @@
<p> If the computation doesn't seem to go anywhere, just clicking the "Stop" button should do. The program will still show you the result of its
computations, you so might see some total nonsense. </p>

<p> Note that the speed of computation will highly depend on your hardware (obvisously). In particular, having several logical cores will definitely
speed it up.</p>
<p> Note that the speed of computation will depend on your hardware (obvisously). In particular, having several logical cores will definitely
speed it up. Also, it seems that Linux does a better job than Windows, and 64 bits systems are faster than 32 bits systems.</p>

<h3> The interface is slow and lagging / freezing... </h3>
<p> We haven't tried the program on many computers yet, but it's possible that some features are demanding in terms of performances, especially if
Expand Down

0 comments on commit 0098d1f

Please sign in to comment.