[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[GNUnet-SVN] [taler-schemafuzz] branch master updated: Some more text. M
|
From: |
gnunet |
|
Subject: |
[GNUnet-SVN] [taler-schemafuzz] branch master updated: Some more text. Move instructions to README. |
|
Date: |
Sat, 25 Aug 2018 02:01:11 +0200 |
This is an automated email from the git hooks/post-receive script.
erwan-ulrich pushed a commit to branch master
in repository schemafuzz.
The following commit(s) were added to refs/heads/master by this push:
new 897d210 Some more text. Move instructions to README.
897d210 is described below
commit 897d21099658c594686c7144c695d0d443336ad1
Author: Feideus <address@hidden>
AuthorDate: Sat Aug 25 02:01:07 2018 +0200
Some more text. Move instructions to README.
---
Documentation.pdf | Bin 0 -> 286590 bytes
README.md | 178 +++++++++++++++----------------------------
docs/PersonnalExperience.pdf | Bin 0 -> 39544 bytes
docs/PersonnalExperience.tex | 40 ++++++++++
4 files changed, 103 insertions(+), 115 deletions(-)
diff --git a/Documentation.pdf b/Documentation.pdf
new file mode 100644
index 0000000..e25f5aa
Binary files /dev/null and b/Documentation.pdf differ
diff --git a/README.md b/README.md
index 5ad0648..5fdec9d 100755
--- a/README.md
+++ b/README.md
@@ -1,115 +1,63 @@
-# [Schema Spy](http://schemaspy.org/) - [schemaspy.org](http://schemaspy.org/)
-
-[](https://travis-ci.org/schemaspy/schemaspy)
-[](http://schemaspy.readthedocs.io/en/latest/?badge=latest)
-[](https://sonarcloud.io/dashboard?id=org.schemaspy%3Aschemaspy)
-[](https://sonarcloud.io/dashboard?id=org.schemaspy%3Aschemaspy)
-[](https://gitter.im/schemaspy/schemaspy?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
-[](https://hub.docker.com/r/schemaspy/schemaspy/)
-
-> Please support a project by simply putting a Github star.
-Share this library with friends on Twitter and everywhere else you can.
-
-> If you notice bug or have something not working please report an issue,
we'll try to fix it as soon as possible.
-More documentation and features expected to be soon. Feel free to contribute.
-
-This is a new code repository for SchemaSpy tool initially created and
maintained by John Currier.
-I'm personally believe that work on SchemaSpy should be continued and a lot of
still existing issue should be resolved.
-Last released version of the SchemaSpy was two years ago, and I have plan to
change this.
-
-I would like to say thank you to John Currier for invent this database
entity-relationship (ER) diagram generator.
-
-In next days I have plan to release new SchemaSpy version and concentrate to
refactor and improve the solution.
-In new **SchemaSpy 6.0** version you will find:
-
-This is a minor change
-
-1. Absolutely new amazing look and feel generated content
-
-2. You can very easily change SchemaSpy theme because all of the logic was
moved outside the Java code
-
-3. Speed of database generation was little improve
-
-4. Generation of the html pages was changed from plain concatenaited text in
Java code to Moustache engine
-
-5. In database comments you can use Markdown language what should improve user
experience from reading your database documentation
-
-6. You can also easily create in database comments links to the tables and
columns
-
-More detail will came in next days plus I have in plan to start working on all
not resolved issues.
-
-## Documentation
-
-If you need more info about how to use or install SchemaSpy please read the
last documentation at Read the Docs.
-
-[Documentation](http://schemaspy.readthedocs.io/en/latest/)
-
-[Sample Output](http://schemaspy.org/sample/index.html)
-
-[](http://schemaspy.org/sample/index.html)
-
-## SchemaSpy v6.0.0 RC2
-[Release Notes](https://github.com/schemaspy/schemaspy/releases/tag/v6.0.0-rc2)
-
-[Download](https://github.com/schemaspy/schemaspy/releases/download/v6.0.0-rc2/schemaspy-6.0.0-rc2.jar)
-
-## Latest Build
-
-To verify fixes and new features you can download our latest build.
-
address@hidden(https://github.com/schemaspy/schemaspy/raw/gh-pages/schemaspy-6.0.0-rc2.jar)
-
-## Docker
-
-We publish snapshot and release to
[hub.docker.io](https://hub.docker.com/r/schemaspy/schemaspy/)
-
-## Bugs and Issues
-
-Have a bug or an issue with SchemaSpy? [Open a new
issue](https://github.com/schemaspy/schemaspy/issues) here on GitHub.
-
-## Contribution
-Are very welcome! And remember, contribution is not only PRs and code, but any
help with docs or helping other developers to solve issues are very
appreciated! Thanks in advance!
-
-### Build Instructions
-#### Application
-SchemaSpy is built using maven and we utilize the maven wrapper.
-__Windows__ `mvnw.cmd package`
-__Linux__ `./mvnw package`
-The resulting application can be found in `target`
-
-##### Analyzing
-You need your own SonarQube:
-https://hub.docker.com/_/sonarqube/
-__Windows__ `mvnw.cmd -P sonar clean verify
-Dsonar.host.url=http://$(boot2docker ip):9000
-Dsonar.jdbc.url="jdbc:h2:tcp://$(boot2docker ip)/sonar"`
-__Linux__ `./mvnw -P sonar clean verify`
-
-Watch results at:
-__Linux__ `http://localhost:9000`
-__Windows__ `http://$(boot2docker ip):9000`
-
-#### Documentation
-You'll need sphinx installed http://www.sphinx-doc.org
-Navigate into `docs`
-__Windows__ `make.bat html`
-__Linux__ `make html`
-The resulting documentation can be found in `docs/build/html`
-
-## Maintained
-
-SchemaSpy is maintained by [Rafal Kasa](malito:address@hidden) with SchemaSpy
community support please contact with me if you have some question or
proposition.
-* https://github.com/rafalkasa
-
-## Team Tools
-
-[](https://www.jetbrains.com/)
-
-SchemaSpy Team would like inform that JetBrains is helping by provided IDE to
develop the application. Thanks to its support program for an Open Source
projects !
-
-[](https://sonarcloud.io/dashboard?id=org.schemaspy%3Aschemaspy)
-
-SchemaSpy project is using SonarCloud for code quality.
-Thanks to SonarQube Team for free analysis solution for open source projects.
-
-
-
-Try
+\section{Usage}
+ \subsection{prerequisites}
+ SchemaFuzz requires the presence of a list of libraries
to work properly which are :
+ \begin{itemize}
+ \item org.apache.commons.math3 >= 3.6
+ available at \\*
+
\url{https://commons.apache.org/proper/commons-math/download_math.cgi}
+ \end{itemize}
+The library has to be installed in the maven repository to be available. The
instructions detailed at the following address explain how to do that. futher
information can be found on the official maven website.\\*
+
+
\url{https://www.mkyong.com/maven/how-to-include-library-manully-into-maven-local-repository/}
+
+ \subsection{setting up the code}
+ Once all the depencies have been installed
successfully, clone the source available on the official git taler repository
\\*
+ \url{https://git.taler.net/schemafuzz.git}
+ \begin{verbatim}
+ git clone https://git.taler.net/schemafuzz.git
+ \end{verbatim}
+
+the folder containing the code shoud hold the rights for reading writing and
executing (rwx) for the user that plans to run the tool.
+if this is not the case, you can give these rights like so
+ \begin{verbatim}
+ sudo chmod -R 700 schemafuzz
+ \end{verbatim}
+ \subsection{Building}
+SchemaFuzz is using maven for building and library management purposes.
+Therefore, using the maven command line building script is way to go.
+Standard way of building :\\*
+ \begin{verbatim}
+ ./mvnw package
+ \end{verbatim}
+
+This maven building method also offers alternative instructions for more
precise/refined way of building as well as compilation and test
+launching options (those should only be intresting for the contributors).
+
+Launching the test suit :\\*
+ \begin{verbatim}
+ ./mvnw test
+ \end{verbatim}
+Compiling the code :\\*
+ \begin{verbatim}
+ ./mvnw compile
+ \end{verbatim}
+
+Other usefull commands: \\*
+
+ \begin{verbatim}
+ ./mvnw clean
+ \end{verbatim}
+ \begin{verbatim}
+ ./mvnw validate
+ \end{verbatim}
+ \begin{verbatim}
+ ./mvnw deploy
+ \end{verbatim}
+
+ \subsection{Setting up the database}
+
+Launch the "dbConfigure" script.
+ \begin{verbatim}
+ ./dbConfigure
+ \end{verbatim}
+
diff --git a/docs/PersonnalExperience.pdf b/docs/PersonnalExperience.pdf
new file mode 100644
index 0000000..10461b3
Binary files /dev/null and b/docs/PersonnalExperience.pdf differ
diff --git a/docs/PersonnalExperience.tex b/docs/PersonnalExperience.tex
new file mode 100644
index 0000000..f138a7b
--- /dev/null
+++ b/docs/PersonnalExperience.tex
@@ -0,0 +1,40 @@
+\documentclass{article}
+\usepackage[english]{babel}
+
+\title{Documentation for schemaFuzz}
+\author{Ulrich "Feideus" Erwan}
+
+\begin{document}
+
+
+
+\section{Internship organisation}
+ \subsection{Introduction}
+
+This section is meant to be added to the University version of this
documentation. It will be written as Erwan Ulrich and will focus on the
different aspects of the organisation of the project. The folllowing text will
also be written with a more personnal and more critical point of view as a mean
of self analysement.
+
+ \subsection{Calendars}
+
+The SchemaFuzz project has had since its genesis a quiet clear view of how
the development should evolve. The desired features have been discussed and the
big picture had been designed to fit the time that the main developer had for
his work at this position.
+The project had to pass trough different phases of development that are
detailed in the following timeline diagram. %% insert timeline diagram here.
+
+Some of the tasks of the above timeline were completed on time, some others
were delivered late, and some were delayed in the timeline because of the
previous point.
+In the end, the project was lead in a way that is best described by the
following timeline diagram. %% insert timeline diagram here.
+
+Those two diagrams differ on some points. This is one of the major failures
for the development of this project throughout the course of these 6 months.
+There are several reasons that explain why this project could have been lead
in a better way.
+they will be detailled and discussed in the next section.
+
+ \subsection{Organisationnal failures}
+This section has a particular value in this report, it is on the first hand a
description of why the SchemaFuzz did not meet all of its defined goals.
+Other the other hand, it is a personnal reminder of what should be improved in
my work habbits and general organisation when leading a project of such a large
size.
+
+ \begin{itemize}
+ \item{Defining tasks/features as daily/weekly sub goals}
+ \item{Improving multitasking} %% bad title.
+ \item{Setting up more fluid communication}
+ \end{itemize}
+
+ \subsection{Positive outcomes}
+
+\end{document}
\ No newline at end of file
--
To stop receiving notification emails like this one, please contact
address@hidden
| [Prev in Thread] |
Current Thread |
[Next in Thread] |
- [GNUnet-SVN] [taler-schemafuzz] branch master updated: Some more text. Move instructions to README.,
gnunet <=