From 827c8fff75fc8adec8b63da654150b4db4b94116 Mon Sep 17 00:00:00 2001 From: Stephen Williams Date: Mon, 26 Dec 2022 09:08:34 -0800 Subject: [PATCH] Rewrite page to describe version branches, --- Home.md | 25 +++++++++++++++++++++++++ Home.textile | 3 --- 2 files changed, 25 insertions(+), 3 deletions(-) create mode 100644 Home.md delete mode 100644 Home.textile diff --git a/Home.md b/Home.md new file mode 100644 index 0000000..ade3071 --- /dev/null +++ b/Home.md @@ -0,0 +1,25 @@ +This is the iverilog GIT repository. + +If you are looking for the main Icarus Verilog documentation, look here: "https://steveicarus.github.io/iverilog/":https://steveicarus.github.io/iverilog/ + +# Version Branches + +There are various trans branches around, for different purposes, but the version branches are those that reflect the versions available. It is preferred that one not commit directly to the version branches, but instead create PR's that are merged. In fact, only the core maintainers are even allowed to commit or merge to these branches, so the general plan is to create a branch that you work in, then create a PR off a version branch to arrange for your branch to be merged. + +When you get a "git clone", you are generally dropped in the "master" branch. to creat a locak tracking branch of one of the version branches, use a command like this (assuming that "origin" is the name you gave to the remote): +``` +% git checkout --track -b v11-branch origin/v11-branch +``` + +## master + +This is the main development branch and is the default branch when you do a git clone and don't otherwise switch to a branch. Mot development happens here. + +## v11-branch + +This is the branch for the stable v11 release. + +## v10-branch + +This is the branch for gthe stable v10 release. +V10 is now obsolete. You should be using V11 if you need a stable version. diff --git a/Home.textile b/Home.textile deleted file mode 100644 index 4a17e54..0000000 --- a/Home.textile +++ /dev/null @@ -1,3 +0,0 @@ -This is the iverilog GIT repository. The Icarus Verilog wiki is at "http://iverilog.wikia.com":http://iverilog.wikia.com. - -There are interesting development statistics available here at "http://www.ohloh.net/p/iverilog":http://www.ohloh.net/p/iverilog.