Difference between revisions of "Getting started with Gramps master"

From Gramps
Jump to: navigation, search
(Installing GRAMPS 3)
m (Running parallel versions of trunk and branches: outdated statement)
(23 intermediate revisions by 7 users not shown)
Line 1: Line 1:
[[Category:Developers/General]]
+
Gramps trunk is the newest version of Gramps, but it is under development. You can help by trying this version and reporting feedback and bugs. Before embarking on this you should first read this page.
 
 
GRAMPS 3 is the newest version of GRAMPS, but it isn't quite finished. It is in a state called "beta" which means that it is nearly done, but there are still places that need some refinement. You can help by trying this version and reporting feedback and bugs. Before embarking on this you should first read this page.
 
 
 
A word of caution: GRAMPS 3.0 is currently considered a ''development version'' and not for use on your real data. You can test GRAMPS 3.0
 
on a copy of your data though. See below for more details.
 
 
 
You should not ''install'' GRAMPS 3.0 as that will overwrite your regular GRAMPS. However, you can download and compile 3.0 locally, largely without interfering with your regular GRAMPS. Subtle interactions are easy to resolve for developers. Currently it is known that:
 
 
 
# closing GRAMPS 3.0 on the Noteview will crash GRAMPS 2.2.10 on startup
 
# create a filter in GRAMPS 3.0 that does not exist in 2.2.10 will cause problems
 
 
 
There are easy ways to fix these, however. Having given these warnings, it is also true that every week it gets closer to completion and we need testers. So, weigh the pros and cons and decide for yourself if you'd like to be an earlier adopter and tester.
 
 
 
== What's new in GRAMPS 3? ==
 
 
 
There are many changes in GRAMPS 3. This section briefly describes the changes and their implications. For a detailed list of changes, see the [[Roadmap]].
 
 
 
=== New Family Tree Database ===
 
 
 
Perhaps the most import change in GRAMPS 3 is the new Family Tree database format. This has a number of features. The new Family Tree Manager also has an integrated revision control system. This allows easy, one-click access to your backups series. For more details and screen shots, see [[Database_Formats#The_Future_-_GRAMPS_3.0|Database Formats: GRAMPS 3]].
 
  
=== New Screens and Functionality ===
+
{{man warn|Warning:|A word of caution: trunk is currently considered a ''development version'' and not for use on your real data. You can test trunk on a copy of your data though. See below for more details.}}
  
# Quick Views - in most lists, you can right-click and run a Quick View. Further, on a Quick View you can double-click and entry and be taken to the associated object to view or edit. Quick View lists are also sortable on their columns
+
You should not ''install'' Gramps trunk as that will overwrite your regular Gramps. However, you can download and compile trunk locally, largely without interfering with your regular Gramps. Subtle interactions are easy to resolve for developers.  
# Gramplets - Gramplets is an experimental new main view in GRAMPS. These are little interfaces to GRAMPS functionality. There are Gramplets that allow you to compute ages on a particular date (Age on Date), see events on a day in history (Calendar), see the top surnames in your Family Tree (Top Surnames), a TODO list, Python shell (with date calculator), a Session Log, and more. There isn't any real documentation yet, but you can find more detail at the proposal [[GEPS 004: My GRAMPS and Gadgets|GEPS 004]].
 
# Notes - There is now a sophisticated method for attaching notes to any object, and a new Notes main view, complete with filter to find exactly what you're looking for.
 
# Print Preview -
 
# New reports -
 
# New tools -
 
  
 
== Precautions ==
 
== Precautions ==
  
GRAMPS 3 should only be used on a copy of your Family Tree data! Here is a step-by-step guide to doing this:
+
Gramps trunk should only be used on a copy of your Family Tree data! Here is a step-by-step guide to doing this:
  
# Start your old version of GRAMPS
+
# Start your old version of Gramps
# Export your data using the GRAMPS Package
+
# Export your data using the Gramps Package
# Quit your old version of GRAMPS
+
# Quit your old version of Gramps
# Start GRAMPS 3.0
+
# Start Gramps trunk
 
# Create a new Family Tree
 
# Create a new Family Tree
# Import the GRAMPS package from step 2
+
# Import the Gramps package from step 2
  
== Can I run my older version of GRAMPS with this new version? ==
+
== Can I run my older version of Gramps with this new version? ==
  
 
Yes. See installation notes below.
 
Yes. See installation notes below.
Line 47: Line 22:
 
== I have a suggestion or have found a bug. What do I do? ==
 
== I have a suggestion or have found a bug. What do I do? ==
  
Please make a note of your Feature Request, or your bug here: http://bugs.gramps-project.org/ This is one of the most important things you can do to help the state of GRAMPS.
+
Please make a note of your Feature Request, or your bug here: http://bugs.gramps-project.org/ This is one of the most important things you can do to help the state of Gramps.
  
== Can I help finish GRAMPS 3? ==
+
== Can I help with Gramps trunk? ==
  
Yes! There is much left to be done. You could:
+
Yes! You could:
  
# Help write documentation on how to use GRAMPS 3. See [[Gramps 3.0 Wiki Manual]]
+
# Help write documentation on how to use Gramps trunk. See [[User manual|Gramps X.x User Wiki Manual]]
# Help translate GRAMPS into another language. See [[Template:Developers/Internationalization|Internationalization]]
+
# Help translate Gramps into another language. See [[Portal:Translators|Internationalization]]
 
# Test and follow-up on issues in the tracker. See http://bugs.gramps-project.org/
 
# Test and follow-up on issues in the tracker. See http://bugs.gramps-project.org/
# Donate money to GRAMPS. See [[GRAMPS:Site_support|GRAMPS Support]]
+
# Donate money to Gramps. See [[GRAMPS:Site_support|Gramps Support]]
  
== Installing GRAMPS 3 ==
+
== Installing Gramps Trunk ==
  
Now that you have read all of the precautions, you are ready to begin exploring GRAMPS 3.  
+
Now that you have read all of the precautions, you are ready to begin exploring Gramps trunk.  
  
* '''Windows systems''': follow the directions at http://www.dancingpaper.com/gramps/.
+
* '''Windows systems''': follow the directions at ?.
 
* '''Unix-like systems''': follow the rest of this page.
 
* '''Unix-like systems''': follow the rest of this page.
  
The easiest method of getting the beta version is to download it from http://sourceforge.net/project/showfiles.php?group_id=25770 under '''Unstable'''. This is easy to get and install, but is probably a few weeks old. If you want to get the freshest code, you'll have to do a little more work. See [[Running a development version of Gramps]].
+
The easiest method of getting the beta/trunk version is to download it from http://gramps.svn.sourceforge.net/viewvc/gramps/trunk/ using the link at the bottom of the page called '''[http://gramps.svn.sourceforge.net/viewvc/gramps/trunk/?view=tar Download GNU tarball]'''. This is easy to download, it is the freshest code, and you will have to do a little more work.  
  
If you are running Linux and a variation of Debian (Ubuntu), then you can download the .deb file and install it directly.
+
See [[Getting_started_with_Gramps_development#Run_Gramps_from_the_source|running Gramps from source]] for details to make the code work.
  
Otherwise, you should download the tar.gz file. Here is the basic installation instructions, assuming that the tar.gz file is in your current directory:
+
== Running parallel versions of trunk and branches ==
  
tar xfz gramps-2.90.0-beta.tar.gz
+
As stated in '''Installing Gramps trunk''', you can only have a dedicated gramps.mo file on /usr/share/local/xx/.. . If you want to have both the trunk and branches version with separate translations, consider using some '''[http://en.wikipedia.org/wiki/Comparison_of_platform_virtual_machines Virtual Machines]'''.
cd gramps-2.90.0-beta
 
./configure --prefix=/usr/local
 
make
 
su -c "make install"
 
  
You can then run /usr/local/bin/gramps
+
== See also ==
 +
* [[$GRAMPSHOME]]
 +
* [[Installation alternatives]]
  
Warning: you will not be able to load translations on /usr/local/share/locale, because you will load /usr/share/locale, which could be translations for stable release (set on gramps.py).
+
[[Category:Developers/General]]
You may generate a custom launcher by adding this line:
 
export GRAMPSI18N=/usr/local/share/locale
 
if you want to use an other path, you may add this line:
 
export GRAMPSI18N=@prefix@/share/locale
 
on current gramps.sh.in (source file) before compillation and installation.
 
 
 
== running parallel versions of trunk and branches ==
 
 
 
As stated in '''Installing GRAMPS 3''', you can only have a dedicated gramps.mo file on /usr/share/local/xx/.. . If you want to have both the trunk and branches version with separate translations, consider using some '''Virtual Machines'''.
 
 
 
At the moment I experiment with this setup:
 
* Ubuntu 7.10: running VirtualBox
 
** VM1: Linux Mint : on this machine I build and installed trunk. This means running ./autogen script, make AND do a make install (as root)
 
** VM2: Fedora 8 : on this machine I build and installed branches. This means running ./autogen script, make AND do a make install (as root)
 

Revision as of 22:17, 24 January 2013

Gramps trunk is the newest version of Gramps, but it is under development. You can help by trying this version and reporting feedback and bugs. Before embarking on this you should first read this page.

Gnome-important.png
Warning:

A word of caution: trunk is currently considered a development version and not for use on your real data. You can test trunk on a copy of your data though. See below for more details.

You should not install Gramps trunk as that will overwrite your regular Gramps. However, you can download and compile trunk locally, largely without interfering with your regular Gramps. Subtle interactions are easy to resolve for developers.

Precautions

Gramps trunk should only be used on a copy of your Family Tree data! Here is a step-by-step guide to doing this:

  1. Start your old version of Gramps
  2. Export your data using the Gramps Package
  3. Quit your old version of Gramps
  4. Start Gramps trunk
  5. Create a new Family Tree
  6. Import the Gramps package from step 2

Can I run my older version of Gramps with this new version?

Yes. See installation notes below.

I have a suggestion or have found a bug. What do I do?

Please make a note of your Feature Request, or your bug here: http://bugs.gramps-project.org/ This is one of the most important things you can do to help the state of Gramps.

Can I help with Gramps trunk?

Yes! You could:

  1. Help write documentation on how to use Gramps trunk. See Gramps X.x User Wiki Manual
  2. Help translate Gramps into another language. See Internationalization
  3. Test and follow-up on issues in the tracker. See http://bugs.gramps-project.org/
  4. Donate money to Gramps. See Gramps Support

Installing Gramps Trunk

Now that you have read all of the precautions, you are ready to begin exploring Gramps trunk.

  • Windows systems: follow the directions at ?.
  • Unix-like systems: follow the rest of this page.

The easiest method of getting the beta/trunk version is to download it from http://gramps.svn.sourceforge.net/viewvc/gramps/trunk/ using the link at the bottom of the page called Download GNU tarball. This is easy to download, it is the freshest code, and you will have to do a little more work.

See running Gramps from source for details to make the code work.

Running parallel versions of trunk and branches

As stated in Installing Gramps trunk, you can only have a dedicated gramps.mo file on /usr/share/local/xx/.. . If you want to have both the trunk and branches version with separate translations, consider using some Virtual Machines.

See also