Skip to content

Commit

Permalink
Merge pull request #158 from JuliaImGui/docs-rename
Browse files Browse the repository at this point in the history
Update links to point to the new repo
  • Loading branch information
JamesWrigley authored Dec 21, 2024
2 parents fb625a6 + e3a257b commit eccc819
Show file tree
Hide file tree
Showing 6 changed files with 14 additions and 14 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
# CImGui

[![Build Status](https://github.com/Gnimuc/CImGui.jl/workflows/CI/badge.svg)](https://github.com/Gnimuc/CImGui.jl/actions/workflows/ci.yml)
[![Build Status](https://github.com/JuliaImGui/CImGui.jl/workflows/CI/badge.svg)](https://github.com/JuliaImGui/CImGui.jl/actions/workflows/ci.yml)
[![pkgeval](https://juliahub.com/docs/CImGui/pkgeval.svg)](https://juliahub.com/ui/Packages/CImGui/HqG2H)
[![version](https://juliahub.com/docs/General/CImGui/stable/version.svg)](https://juliahub.com/ui/Packages/General/CImGui)
[![codecov](https://codecov.io/gh/Gnimuc/CImGui.jl/graph/badge.svg?token=KLCkl2pB7N)](https://codecov.io/gh/Gnimuc/CImGui.jl)
[![codecov](https://codecov.io/gh/JuliaImGui/CImGui.jl/graph/badge.svg?token=KLCkl2pB7N)](https://codecov.io/gh/JuliaImGui/CImGui.jl)
[![](https://img.shields.io/badge/design%20principle-KISS-orange)](https://en.wikipedia.org/wiki/KISS_principle)
[![](https://img.shields.io/badge/docs-stable-blue.svg)](https://Gnimuc.github.io/CImGui.jl/stable)
[![](https://img.shields.io/badge/docs-dev-blue.svg)](https://Gnimuc.github.io/CImGui.jl/dev)
![GitHub Discussions](https://img.shields.io/github/discussions/Gnimuc/CImGui.jl)
[![](https://img.shields.io/badge/docs-stable-blue.svg)](https://JuliaImGui.github.io/CImGui.jl/stable)
[![](https://img.shields.io/badge/docs-dev-blue.svg)](https://JuliaImGui.github.io/CImGui.jl/dev)
![GitHub Discussions](https://img.shields.io/github/discussions/JuliaImGui/CImGui.jl)
[![deps](https://juliahub.com/docs/CImGui/deps.svg)](https://juliahub.com/ui/Packages/CImGui/HqG2H?t=2)

This package provides a Julia language wrapper for
Expand All @@ -20,4 +20,4 @@ use cases.

![demo](demo/demo.png)

See the [documentation](https://Gnimuc.github.io/CImGui.jl/stable) for more info.
See the [documentation](https://juliaimgui.github.io/CImGui.jl/stable) for more info.
6 changes: 3 additions & 3 deletions docs/make.jl
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Changelog.generate(
Changelog.Documenter(),
joinpath(@__DIR__, "src/_changelog.md"),
joinpath(@__DIR__, "src/changelog.md"),
repo="Gnimuc/CImGui.jl"
repo="JuliaImGui/CImGui.jl"
)

makedocs(;
Expand All @@ -21,7 +21,7 @@ makedocs(;
sitename="CImGui.jl",
format=Documenter.HTML(;
prettyurls=get(ENV, "CI", "false") == "true",
canonical="https://Gnimuc.github.io/CImGui.jl",
canonical="https://juliaimgui.github.io/CImGui.jl",
assets=String[],
size_threshold=2_000_000,
size_threshold_warn=1_500_000
Expand All @@ -30,5 +30,5 @@ makedocs(;
)

deploydocs(;
repo="github.com/Gnimuc/CImGui.jl.git",
repo="github.com/JuliaImGui/CImGui.jl.git",
)
4 changes: 2 additions & 2 deletions docs/src/_changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ CurrentModule = CImGui
This documents notable changes in CImGui.jl. The format is based on [Keep a
Changelog](https://keepachangelog.com).

## [v4.0.0] - 2024-11-19
## [v4.0.0] - 2024-12-21

### Changed
- **Breaking**: We updated to [Dear ImGui
Expand All @@ -22,7 +22,7 @@ Changelog](https://keepachangelog.com).
respectively.

For Linux/GLFW users, there's also a fix for a long-standing docking bug:
https://github.com/ocornut/imgui/issues/7733
<https://github.com/ocornut/imgui/issues/7733>

## [v3.1.1] - 2024-11-05

Expand Down
2 changes: 1 addition & 1 deletion docs/src/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ julia> julia_demo()
```

[All of these
examples](https://github.com/Gnimuc/CImGui.jl/tree/master/examples) are
examples](https://github.com/JuliaImGui/CImGui.jl/tree/master/examples) are
one-to-one ported from [Dear ImGui's C++
examples](https://github.com/ocornut/imgui/blob/master/imgui_demo.cpp) and there
is an [interactive
Expand Down
2 changes: 1 addition & 1 deletion docs/src/makie.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ It supports all the interaction features in GLMakie:
- Ctrl + left click to reset the limits

Here's a quick demo using
[`examples/makie_demo.jl`](https://github.com/Gnimuc/CImGui.jl/blob/master/examples/makie_demo.jl)
[`examples/makie_demo.jl`](https://github.com/JuliaImGui/CImGui.jl/blob/master/examples/makie_demo.jl)
(you may want to `Right click -> Open in new tab` to see it in full resolution):
![Makie demo](assets/makie-demo.gif)

Expand Down
2 changes: 1 addition & 1 deletion src/CImGui.jl
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ end
tooltip=true, stats=false)
Display a Makie figure in ImGui. See
[`examples/makie_demo.jl`](https://github.com/Gnimuc/CImGui.jl/blob/master/examples/makie_demo.jl)
[`examples/makie_demo.jl`](https://github.com/JuliaImGui/CImGui.jl/blob/master/examples/makie_demo.jl)
for an example of how to use it.
These are the [interaction
Expand Down

6 comments on commit eccc819

@JamesWrigley
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@JuliaRegistrator
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Error while trying to register: Changing package repo URL not allowed, please submit a pull request with the URL change to the target registry and retry.

@JamesWrigley
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@JuliaRegistrator
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Registration pull request created: JuliaRegistries/General/121836

Tip: Release Notes

Did you know you can add release notes too? Just add markdown formatted text underneath the comment after the text
"Release notes:" and it will be added to the registry PR, and if TagBot is installed it will also be added to the
release that TagBot creates. i.e.

@JuliaRegistrator register

Release notes:

## Breaking changes

- blah

To add them here just re-invoke and the PR will be updated.

Tagging

After the above pull request is merged, it is recommended that a tag is created on this repository for the registered package version.

This will be done automatically if the Julia TagBot GitHub Action is installed, or can be done manually through the github interface, or via:

git tag -a v4.0.0 -m "<description of version>" eccc81945a0fdb6b291666b98047bf893750ef87
git push origin v4.0.0

@JamesWrigley
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@JuliaRegistrator register

Release notes:

See the changelog for breaking changes: https://juliaimgui.github.io/CImGui.jl/stable/changelog/

@JuliaRegistrator
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Registration pull request updated: JuliaRegistries/General/121836

Tagging

After the above pull request is merged, it is recommended that a tag is created on this repository for the registered package version.

This will be done automatically if the Julia TagBot GitHub Action is installed, or can be done manually through the github interface, or via:

git tag -a v4.0.0 -m "<description of version>" eccc81945a0fdb6b291666b98047bf893750ef87
git push origin v4.0.0

Please sign in to comment.